Skip to content

Add rolldice reference application (FastAPI)#5244

Open
reggied wants to merge 8 commits into
open-telemetry:mainfrom
reggied:reference_app
Open

Add rolldice reference application (FastAPI)#5244
reggied wants to merge 8 commits into
open-telemetry:mainfrom
reggied:reference_app

Conversation

@reggied

@reggied reggied commented May 21, 2026 •
edited
Loading

Copy link
Copy Markdown

Description

Implements the OpenTelemetry reference application specification [1] with both uninstrumented and instrumented versions of a FastAPI dice-rolling service. The instrumented version uses declarative (file-based) YAML configuration for the telemetry pipeline with OTLP HTTP and console exporters for all three signal types (traces, metrics, logs).

[1] https://opentelemetry.io/docs/getting-started/reference-application-specification/

Fixes # #5167

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@linux-foundation-easycla

linux-foundation-easycla Bot commented May 21, 2026 •
edited
Loading

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

@reggied
Add rolldice reference application (FastAPI)
2b97f1e 
Implements the OpenTelemetry reference application specification [1] with
both uninstrumented and instrumented versions of a FastAPI dice-rolling
service. The instrumented version uses declarative (file-based) YAML
configuration for the telemetry pipeline with OTLP HTTP and console
exporters for all three signal types (traces, metrics, logs).

[1] https://opentelemetry.io/docs/getting-started/reference-application-specification/

Assisted-by: Claude Opus 4.6
reggied and others added 2 commits May 28, 2026 08:34
@reggied
Merge branch 'open-telemetry:main' into reference_app
4392aa3
@reggied
Address reference app specification compliance gaps
d871490 
Add OS resource detector, OTEL_LOG_LEVEL diagnostic verbosity control,
dynamic OTEL_SERVICE_NAME support via env var substitution, and a CI
workflow that smoke-tests both the instrumented and uninstrumented
variants of the rolldice application.

Co-Authored-By: Claude Opus 4.6 (1M context)
@reggied
Fix style compliance for rolldice reference application
4456610 
Update all license headers to the SPDX two-line format, fix import
sorting and formatting per ruff, and add a towncrier changelog fragment.
@reggied reggied marked this pull request as ready for review May 28, 2026 17:48
@reggied reggied requested a review from a team as a code owner May 28, 2026 17:48
@reggied

reggied commented Jun 8, 2026

Copy link
Copy Markdown
Author

@MikeGoldsmith , could you take a look at this when you get a chance?

@tammy-baylis-swi tammy-baylis-swi moved this to Ready for review in Python PR digest Jun 11, 2026
@tammy-baylis-swi

tammy-baylis-swi commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Thank you for this @reggied ! Have we considered putting it in docs/examples instead? https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples

@reggied

reggied commented Jun 11, 2026

Copy link
Copy Markdown
Author

Thank you for this @reggied ! Have we considered putting it in docs/examples instead? https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples

Hi @tammy-baylis-swi ! I'm new to this repo, so the current location was a best guess. I didn't put it in docs/examples because the modules in there seemed like simple one-file examples whereas this is an entire example application, but if you think that is more appropriate, I can move it. How would you name it?

@tammy-baylis-swi

tammy-baylis-swi commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Hi @tammy-baylis-swi ! I'm new to this repo, so the current location was a best guess. I didn't put it in docs/examples because the modules in there seemed like simple one-file examples whereas this is an entire example application, but if you think that is more appropriate, I can move it. How would you name it?

Nice, welcome 👋

I suggest docs/examples/fastapi-rolldice to align with existing docs/examples/django, and so it will link from https://opentelemetry-python.readthedocs.io/en/stable/examples/ via https://opentelemetry.io/docs/languages/python/. This is definitely a more substantial example than the Django one but I think it's a better fit than say the FastAPI instrumentor source code

@github-actions

github-actions Bot commented Jun 30, 2026

Copy link
Copy Markdown

This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment.
If you're still working on this, please add a comment or push new commits.

@github-actions github-actions Bot added the Stale label Jun 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Stale

Projects

Python PR digest
Status: Ready for review

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@reggied @tammy-baylis-swi